home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 011 / review.arc / REVIEW.DOC < prev    next >
Text File  |  1985-08-08  |  12KB  |  207 lines
  1.                  ----------------------------------------
  2.                 |         *** RE-VIEW  1.8 ***           |
  3.                 |                                        |
  4.                 |  Copyright (C) 1983 by Vincent T. Bly  |
  5.                 |                                        |
  6.                 |   RE-VIEW is a user supported program. |
  7.                 | If you find RE-VIEW useful, send $15   |
  8.                 | to:         Vincent Bly                |
  9.                 |             P. O. Box 409              |
  10.                 |             Ft. Belvoir, VA  22060     |
  11.                 |                                        |
  12.                 |   You are encouraged to give copies of |
  13.                 | this software and documentation to your|
  14.                 | friends.  Please make sure it includes |
  15.                 | the notice above.  Anyone who wishes to|
  16.         | get RE-VIEW directly from the author     |
  17.         | can send $22 which covers the software,|
  18.         | diskette, mailer, and postage.     |
  19.                 |                                        |
  20.                 |   Support will be provided to users who|
  21.                 | have paid for the program.  Send your  |
  22.                 | clearly worded questions to the above  |
  23.                 | address.  A stamped, self-addressed    |
  24.                 | envelope will speed replies.           |
  25.                  ----------------------------------------
  26.  
  27.    GENERAL DESCRIPTION
  28.    -------------------
  29.        RE-VIEW provides enhanced text display capabilities for the IBM PC
  30.    or PC-XT equipped with the standard Color/Graphics Adapter.  It is also
  31.    compatible with the COMPAQ portable computer.  RE-VIEW can be used with
  32.    MS-DOS 1.0, 1.1, or 2.0.  Its main features include:
  33.        a) A 75 line screen buffer which saves text as it scrolls off the
  34.    top of the active display page.
  35.        b) The ability to review the 75 line screen buffer and the active
  36.    display page together as one virtual screen of 100 text lines.
  37.        c) The ability to scroll rapidly up and down the 100 line virtual
  38.    screen, a line at a time or a page (25 lines) at a time.
  39.        d) The ability to quickly pause normal screen display by tapping
  40.    the [Scroll Lock] key.  During the pause, you can review any text in
  41.    the 100 line virtual screen.
  42.        e) The ability to temporarily stop saving new scrolled text, so
  43.    that text already in the buffer is preserved for future reference.
  44.        f) An improved scrolling routine with substantually reduced flicker.
  45.  
  46.    PAGING KEYS
  47.    -----------
  48.        RE-VIEW uses the extreme right-hand [-] and [+] keys for page up and
  49.    page down functions, respectively (the normal [-] and [+] keys are not
  50.    affected).  These keys are used by RE-VIEW to avoid incompatibility with
  51.    other programs which use the [Pg Up] and [Pg Dn] keys for their own
  52.    purposes.
  53.        In the text below, "rgt[-]" and "rgt[+]" signify the extreme right-
  54.    hand [-] and [+] keys, respectively.  "<shft>rgt[-]" and "<shft>rgt[+]"
  55.    signify the shifted right-hand [-] and [+] keys.
  56.  
  57.    LIMITATIONS
  58.    -----------
  59.        RE-VIEW only operates with the Color/Graphics Adapter.  It is NOT
  60.    compatible with the Monochrome Display Adapter.  RE-VIEW's main features
  61.    operate in the 80 column text mode only (although the quick pause feature
  62.    can be used from any display mode).  Also, the DOS 2.0 ANSI.SYS device
  63.    driver is not compatible with RE-VIEW; however, a patching program is
  64.    provided with RE-VIEW which will create a compatible version of ANSI.SYS.
  65.  
  66.    INSTALLING RE-VIEW
  67.    ------------------
  68.        RE-VIEW can be installed from DOS by typing the command: RE-VIEW
  69.    and pressing return.  Normally, you would include this command in your
  70.    AUTOEXEC.BAT file.  Once RE-VIEW has been installed, it will remain in
  71.    your system--ready to provide the capabilities listed below--until you
  72.    turn your system off or reboot with <Ctrl><Alt>[Del].
  73.  
  74.    USING RE-VIEW
  75.    -------------
  76.        RE-VIEWs features can be used any time your computer is waiting for
  77.    keyboard input.  The function of the keys used by RE-VIEW are as follows:
  78.  
  79.    rgt[-] or rgt[+] ... These keys allow you to quickly scroll up or down
  80.                         through the 100 line virtual screen, a line at a time.
  81.  
  82.    <shft>rgt[-] or <shft>rgt[+] ... These keys allow you to move up or down
  83.                         through the 100 line virtual screen, a page at a time
  84.                         (there are a total of 4 pages).
  85.  
  86.    <Alt>[Scroll Lock] ... This key combination allows you to toggle saving of
  87.                         scrolled text into the 75 line buffer.  In order to
  88.                         help you keep track of the current state--an audible
  89.                         signal will be sounded as follows:
  90.                                    2 BEEPS - scrolled text will be saved,
  91.                                    1 BEEP  - scrolled text will not be saved.
  92.                            This feature can be used to save text created by
  93.                         one program for later review by another.  For example,
  94.                         you could use TYPE to display up to 75 lines of your
  95.                         program source code.  Next, you would scroll the lines
  96.                         off the screen to save them in the 75 line buffer.*
  97.                         Next, you would press <Alt>[Scroll Lock] to prevent
  98.                         future scrolled lines from disturbing the contents of
  99.                         the buffer.  Now, you could enter DEBUG to analyze
  100.                         your program, while--at any time--being able to review
  101.                         your commented source code using RE-VIEW's paging keys
  102.                         (rgt[-], etc.).
  103.                         *  The UP.COM program, included with RE-VIEW, makes
  104.                         scrolling the text into the buffer easier--see the
  105.                         description near the end of this documentation.
  106.  
  107.        RE-VIEW's features can also be used while your computer is displaying
  108.    text on the screen.  First--you must pause the screen display by pressing
  109.    the [Scroll Lock] key.  During the pause you may use the keys listed below:
  110.  
  111.    rgt[-] or rgt[+] ... Scroll up or down through the 100 line virtual
  112.                         screen, a line at a time.
  113.  
  114.    <shft>rgt[-] or <shft>rgt[+] ... Move through the (4 page) virtual screen,
  115.                         a page at a time.
  116.  
  117.    <Alt>[Scroll Lock] ... Toggle between saving and not saving scrolled text.
  118.  
  119.    <Ctrl>[Scroll Lock] = "Break" ... Perform a Break immediately.  Unlike the
  120.                         <Ctrl>[Num Lock] pause, the [Scroll Lock] pause does
  121.                         not throw away the key used to restart.  Therefore you
  122.                         do not need to hit the "Break" key twice.
  123.  
  124.    Any Other Key (including [Scroll Lock]) ... Restart normal screen display.
  125.  
  126.    COMPATIBLE PROGRAMS
  127.    -------------------
  128.        RE-VIEW is compatible with most text producing programs which print
  129.    to the screen using the standard DOS or ROM routines.  Known compatible
  130.    programs include:
  131.                DIR, TYPE, <MORE, TREE, COMP, DEBUG, EDLIN, and BASIC.
  132.  
  133.    DEACTIVATING RE-VIEW
  134.    --------------------
  135.        Some programs will not be compatible with RE-VIEW.  These include:
  136.                         a) programs which access screen memory directly;
  137.                         b) programs which use screen pages other than page 0;
  138.                         c) and, programs which use the same keys as RE-VIEW.
  139.    When you use one of these programs or need to use the right-hand [-] and
  140.    [+] keys for data entry, you can--temporarily--deactivate RE-VIEW by
  141.    pressing <Ctrl><Alt>[Scroll Lock].  When deactivated, RE-VIEW will have
  142.    no effect on system processing except for a small routine which will wait
  143.    for the next press of <Ctrl><Alt>[Scroll Lock], which you can use to
  144.    reactivate RE-VIEW.  NOTE: you should use this feature from DOS, not from
  145.    an application program (for example, you can deactivate RE-VIEW from BASIC,
  146.    but must return to DOS to reactivate it).
  147.  
  148.    USING RE-VIEW WITH BASIC
  149.    ------------------------
  150.        RE-VIEW's features can be very helpful in BASIC, especially when list-
  151.    ing long programs.  It is also compatible with SofTool Systems' BASIC
  152.    Development System (BDS).  However, you should be aware that many BASIC
  153.    programs will destroy the contents of RE-VIEW's screen buffer when they
  154.    are run.  Most WIDTH and SCREEN commands will clear the buffer, some other
  155.    commands may also.  However, this does not affect RE-VIEW's assistance in
  156.    reviewing listing of large BASIC programs or the output of utilities such
  157.    as SofTool's BDS.
  158.  
  159.    AUXILIARY PROGRAMS
  160.    -------------------
  161.        Three auxiliary programs are included with RE-VIEW:
  162.             CLA.COM ....... This program provides the DOS command CLA, which
  163.                             operates like DOS 2.0's CLS command, except that
  164.                             all 100 lines of the virtual screen are cleared.
  165.             UP.EXE ........ This program provides the DOS command UP, which
  166.                             scrolls the text above the cursor just off the
  167.                             top of the screen into the 75 line save buffer.
  168.                             (Use it with <Alt>[Scroll Lock] to save text pro-
  169.                             duced by one program for later review by another.)
  170.             ANSIPCH.EXE ... This program patches DOS 2.0's ANSI.SYS program
  171.                             to provide compatibility with RE-VIEW (see below).
  172.  
  173.    USING RE-VIEW WITH ANSI.SYS
  174.    ---------------------------
  175.        If you are using the DOS 2.0 ANSI.SYS device driver, you will need to
  176.    patch it for compatibility with RE-VIEW.  The original ANSI.SYS does not
  177.    use the standard ROM routines for scrolling.  Therefore, RE-VIEW will be
  178.    ineffective on systems using the original ANSI.SYS driver.  The program,
  179.    ANSIPCH.EXE, creates a patched version of ANSI.SYS which is compatible
  180.    with RE-VIEW and provides all the features of the original ANSI.SYS.
  181.        You can patch ANSI.SYS as follows:
  182.                 1 ... Make sure the disk you are using has a copy of the
  183.                       files "ANSI.SYS" and "ANSIPCH.EXE".
  184.                 2 ... Type ANSIPCH and press return.  In a few seconds, you
  185.                       should see the message -
  186.                       "*** Patch complete. Patched version = ANSIR.SYS ***".
  187.                 3 ... Edit your CONFIG.SYS file, changing the line -
  188.                       "DEVICE = ANSI.SYS" to
  189.                       "DEVICE = ANSIR.SYS".
  190.                 4 ... Re-boot your system to install the patched version of
  191.                       ANSI.SYS.  Now install RE-VIEW by typing RE-VIEW and
  192.                       pressing return; everything should work properly now.
  193.                 Note: ANSIPCH.EXE presumes the original version of ANSI.SYS
  194.                       (dated 03/08/83) is on the default disk drive.  If it
  195.                       is not found, ANSIPCH will abort after displaying the
  196.                       message -
  197.                       "* Cannot open ANSI.SYS *".
  198.                       If ANSI.SYS is found, but does not compare with the
  199.                       original version, ANSIPCH will abort after displaying
  200.                       the message -
  201.                       "* Unfamiliar version of ANSI.SYS, patching aborted. *"
  202.  
  203.    CREDITS
  204.    -------
  205.        IBM is a registered trademark of International Business Machines Corp.
  206.        COMPAQ is a trademark of COMPAQ Computer Corporation.
  207.        BASIC Development System (BDS), copyright (C) SofTool Systems 1982.